Skip to content

Reorganizing ParmEst and Pyomo.DoE Documentation Pages#3904

Open
slilonfe5 wants to merge 5 commits intoPyomo:mainfrom
slilonfe5:parmest-doe-doc-reorg
Open

Reorganizing ParmEst and Pyomo.DoE Documentation Pages#3904
slilonfe5 wants to merge 5 commits intoPyomo:mainfrom
slilonfe5:parmest-doe-doc-reorg

Conversation

@slilonfe5
Copy link
Copy Markdown
Member

@slilonfe5 slilonfe5 commented Apr 3, 2026 •
edited
Loading

Fixes # .

Summary/Motivation:

The ParmEst and Pyomo.DoE documentation webpages need a major reorganization ahead of the American Control Conference Workshop in May. This update will enable new/existing users to access recent/forthcoming capabilities in ParmEst and Pyomo.DoE

Changes proposed in this PR:

  • Remove outdated/non-informative pages from the ParmEst and Pyomo.DoE documentation webpages
  • Update documentation files to capture important features/capabilities in ParmEst and Pyomo.DoE as listed below.
    Proposed ParmEst documentation page:
    - Overview
    - Installation Instructions
    - Quick Start Guide
    - Objective Options
    - Uncertainty Quantification
    - Estimability Analysis
    Proposed Pyomo.DoE documentation page:
    - Overview
    - Quick Start Guide
    - Experiment Abstraction
    - Objective Options
    - Multiple Experiments
    - Parameter Uncertainty

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@sscini sscini moved this to Development in ParmEst & Pyomo.DoE Development Apr 4, 2026
@slilonfe5 slilonfe5 marked this pull request as ready for review April 7, 2026 16:08
@slilonfe5
Copy link
Copy Markdown
Member Author

slilonfe5 commented Apr 7, 2026 •
edited
Loading

@mrmundt @blnicho @jsiirola @adowling2, This PR is ready for review. As mentioned in the description, we want to reorganize the documentation webpages of ParmEst and Pyomo.DoE into a structure that is informative, capturing the most up-to-date capabilities, ahead of the ACC Pyomo workshop in May. This PR is meant to create background documentation files and structures for @sscini and @smondal13 to quickly update after their PRs get merged.

A major question is whether we should remove the other existing ParmEst documentation pages (e.g., data reconciliation, scenario creation).

Thank you.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 8, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.93%. Comparing base (3d3ffae) to head (dbe9f2c).
⚠️ Report is 295 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3904      +/-   ##
==========================================
- Coverage   89.93%   89.93%   -0.01%     
==========================================
  Files         902      902              
  Lines      106393   106393              
==========================================
- Hits        95683    95680       -3     
- Misses      10710    10713       +3
Flag Coverage Δ
builders 29.19% <ø> (+<0.01%) ⬆️
default 86.23% <ø> (?)
expensive 35.64% <ø> (?)
linux 87.38% <ø> (-2.04%) ⬇️
linux_other 87.38% <ø> (ø)
oldsolvers 28.10% <ø> (+<0.01%) ⬆️
osx 82.71% <ø> (ø)
win 85.80% <ø> (-0.01%) ⬇️
win_other 85.80% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@blnicho blnicho self-requested a review May 5, 2026 19:01
@sscini sscini moved this from Development to Ready for design review in ParmEst & Pyomo.DoE Development May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@blnicho blnicho Awaiting requested review from blnicho

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

AT: STALE pyomo.DoE

Projects

ParmEst & Pyomo.DoE Development
Status: Ready for design review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@slilonfe5 @jsiirola @blnicho @pyomo-autotest @sscini